Azure Maps Render Service (preview:1.0)

2025/03/29 • 8 updated methods

Render_GetMapImage (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. Service also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following Gen1 S0, S1 and Gen2 capabilities. In Gen1 S0 you can: - Render up to 5 pushpins specified in the request - Provide one custom image for the pins referenced in the request - Add labels to the pushpins In Gen1 S1 and Gen2 you can: - Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService) - Specify multiple pushpin styles - Render circle, polyline and polygon geometry types. - Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService) For detailed examples, see the how-to guide [Render custom data on a raster map](https://aka.ms/AzureMapsHowToGuideImageCompositor). _Note_ : Either **center** or **bbox** parameter must be supplied to the API.

The supported Lat and Lon ranges when using the **bbox** parameter, are as follows:

|Zoom Level | Max Lon Range | Max Lat Range| |:----------|:----------------|:-------------| |0 | 360.0 | 170.0 | |1 | 360.0 | 170.0 | |2 | 360.0 | 170.0 | |3 | 360.0 | 170.0 | |4 | 360.0 | 170.0 | |5 | 180.0 | 85.0 | |6 | 90.0 | 42.5 | |7 | 45.0 | 21.25 | |8 | 22.5 | 10.625 | |9 | 11.25 | 5.3125 | |10 | 5.625 | 2.62625 | |11 | 2.8125 | 1.328125 | |12 | 1.40625 | 0.6640625 | |13 | 0.703125 | 0.33203125 | |14 | 0.3515625 | 0.166015625 | |15 | 0.17578125 | 0.0830078125 | |16 | 0.087890625 | 0.0415039063 | |17 | 0.0439453125 | 0.0207519531 | |18 | 0.0219726563 | 0.0103759766 | |19 | 0.0109863281 | 0.0051879883 | |20 | 0.0054931641 | 0.0025939941 |
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapImage",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\nThe supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following Gen1 S0, S1 and Gen2 capabilities. \n\nIn Gen1 S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn Gen1 S1 and Gen2 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\n For detailed examples, see the how-to guide [Render custom data on a raster map](https://aka.ms/AzureMapsHowToGuideImageCompositor).\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the API.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n  |Zoom Level | Max Lon Range   | Max Lat Range|\n  |:----------|:----------------|:-------------|\n  |0          | 360.0           | 170.0        | \n  |1          | 360.0           | 170.0        |\n  |2          | 360.0           | 170.0        |\n  |3          | 360.0           | 170.0        |\n  |4          | 360.0           | 170.0        |\n  |5          | 180.0           | 85.0         |\n  |6          | 90.0            | 42.5         |\n  |7          | 45.0            | 21.25        |\n  |8          | 22.5            | 10.625       |\n  |9          | 11.25           | 5.3125       |\n  |10         | 5.625           | 2.62625      |\n  |11         | 2.8125          | 1.328125     |\n  |12         | 1.40625         | 0.6640625    |\n  |13         | 0.703125        | 0.33203125   |\n  |14         | 0.3515625       | 0.166015625  |\n  |15         | 0.17578125      | 0.0830078125 |  \n  |16         | 0.087890625     | 0.0415039063 | \n  |17         | 0.0439453125    | 0.0207519531 |\n  |18         | 0.0219726563    | 0.0103759766 |\n  |19         | 0.0109863281    | 0.0051879883 |\n  |20         | 0.0054931641    | 0.0025939941 |",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\nThe supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following Gen1 S0, S1 and Gen2 capabilities. \n\nIn Gen1 S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn Gen1 S1 and Gen2 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\n For detailed examples, see the how-to guide [Render custom data on a raster map](https://aka.ms/AzureMapsHowToGuideImageCompositor).\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the API.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n  |Zoom Level | Max Lon Range   | Max Lat Range|\n  |:----------|:----------------|:-------------|\n  |0          | 360.0           | 170.0        | \n  |1          | 360.0           | 170.0        |\n  |2          | 360.0           | 170.0        |\n  |3          | 360.0           | 170.0        |\n  |4          | 360.0           | 170.0        |\n  |5          | 180.0           | 85.0         |\n  |6          | 90.0            | 42.5         |\n  |7          | 45.0            | 21.25        |\n  |8          | 22.5            | 10.625       |\n  |9          | 11.25           | 5.3125       |\n  |10         | 5.625           | 2.62625      |\n  |11         | 2.8125          | 1.328125     |\n  |12         | 1.40625         | 0.6640625    |\n  |13         | 0.703125        | 0.33203125   |\n  |14         | 0.3515625       | 0.166015625  |\n  |15         | 0.17578125      | 0.0830078125 |  \n  |16         | 0.087890625     | 0.0415039063 | \n  |17         | 0.0439453125    | 0.0207519531 |\n  |18         | 0.0219726563    | 0.0103759766 |\n  |19         | 0.0109863281    | 0.0051879883 |\n  |20         | 0.0054931641    | 0.0025939941 |"
  }
}

⚼ Request

GET:  /map/static/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Possible value: png. ,
Required: True ,
}
string ,
layer:
{
Description: Map layer requested. If layer is set to labels or hybrid, the format should be png. ,
Required: False ,
}
string ,
style:
{
Description: Map style to be returned. Possible values are main and dark. ,
Required: False ,
}
string ,
zoom:
{
Description: Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.

Please see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: False ,
}
integer ,
center:
{
Description: Coordinates of the center point. Format: 'lon,lat'. Projection used - EPSG:3857. Longitude range: -180 to 180. Latitude range: -85 to 85. Note: Either center or bbox are required parameters. They are mutually exclusive. ,
Required: False ,
}
array ,
bbox:
{
Description: Bounding box. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'. Note: Either bbox or center are required parameters. They are mutually exclusive. It shouldn’t be used with height or width. The maximum allowed ranges for Lat and Lon are defined for each zoom level in the table at the top of this page. ,
Required: False ,
}
array ,
height:
{
Description: Height of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox. ,
Format: int32 ,
Required: False ,
}
integer ,
width:
{
Description: Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox. ,
Format: int32 ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
pins:
{
Description: Pushpin style and instances. Use this parameter to optionally add pushpins to the image. The pushpin style describes the appearance of the pushpins, and the instances specify the coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this parameter since it will contain reserved characters such as pipes and punctuation.) The Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs allow multiple instances of the pins parameter to specify multiple pin styles. To render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the querystring parameter `pins=default||-122 45` Note that the longitude comes before the latitude. After URL encoding this will look like `pins=default%7C%7C-122+45` All of the examples here show the pins parameter without URL encoding, for clarity. To render a pin at multiple locations, separate each location with a pipe character. For example, use `pins=default||-122 45|-119.5 43.2|-121.67 47.12` The S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation. ### Style Modifiers You can modify the appearance of the pins by adding style modifiers. These are added after the style but before the locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help reduce the length of the URL. To change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use a deep pink color which you would specify as #FF1493 in CSS, use `pins=default|coFF1493||-122 45` ### Pushpin Labels To add a label to the pins, put the label in single quotes just before the coordinates. For example, to label three pins with the values '1', '2', and '3', use `pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12` There is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if you want to display labels without any pin image. For example, `pins=none||'A'-122 45|'B'-119.5 43.2` To change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink pushpins with black labels, use `pins=default|coFF1493|lc000000||-122 45` To change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate height of the label text in pixels. For example, to increase the label size to 12, use `pins=default|ls12||'A'-122 45|'B'-119 43` The labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and is at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier and provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the pushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example, to position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image, use `pins=default|la10 -4||'A'-122 45|'B'-119 43` ### Custom Pushpins To use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the location and label information. Use two pipe characters to indicate that you're done specifying locations and are starting the URL. For example, `pins=custom||-122 45||http://contoso.com/pushpins/red.png` After URL encoding, this would look like `pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png` By default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures the location that you're trying to highlight. To override the anchor location of the pin image, use the 'an' style modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom pin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by using `pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png` Note: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB channels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually only be done with a solid-color custom image. ### Getting Pushpins from Azure Maps Data Storage For all Azure Maps account SKUs other than S0, the pushpin location information can be obtained from Azure Maps Data Storage. After uploading a GeoJSON document containing pin locations, the Data Storage service returns a Unique Data ID (UDID) that you can use to reference the data in the pins parameter. To use the point geometry from an uploaded GeoJSON document as the pin locations, specify the UDID in the locations section of the pins parameter. For example, `pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713` Note that only point and multipoint geometry, points and multipoints from geometry collections, and point geometry from features will be used. Linestring and polygon geometry will be ignored. If the point comes from a feature and the feature has a string property called "label", the value of that property will be used as the label for the pin. You can mix pin locations from Data Storage and pin locations specified in the pins parameter. Any of the pipe-delimited pin locations can be a longitude and latitude or a UDID. For example, `pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43` ### Scale, Rotation, and Opacity You can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a value greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and values smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use `pins=default|sc1.5||-122 45` You can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees of clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins 90 degrees clockwise and double their size, use `pins=default|ro90|sc2||-122 45` You can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier. This is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent (and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins and their labels only 67% opaque, use `pins=default|al.67||-122 45` ### Style Modifier Summary Modifier | Description | Range :--------:|-----------------|------------------ al | Alpha (opacity) | 0 to 1 an | Pin anchor | * co | Pin color | 000000 to FFFFFF la | Label anchor | * lc | Label color | 000000 to FFFFFF ls | Label size | Greater than 0 ro | Rotation | -360 to 360 sc | Scale | Greater than 0 * X and Y coordinates can be anywhere within pin image or a margin around it. The margin size is the minimum of the pin width and height. ,
Required: False ,
}
array ,
path:
{
Description: Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image. The path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this parameter since it will contain reserved characters such as pipes and punctuation.) Path parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter allow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and number of locations is limited to 100 per path. To render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the querystring parameter `path=ra100||-122 45` Note that the longitude comes before the latitude. After URL encoding this will look like `path=ra100%7C%7C-122+45` All of the examples here show the path parameter without URL encoding, for clarity. To render a line, separate each location with a pipe character. For example, use `path=||-122 45|-119.5 43.2|-121.67 47.12` To render a polygon, last location must be equal to the start location. For example, use `path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45` Longitude and latitude values for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian. ### Style Modifiers You can modify the appearance of the path by adding style modifiers. These are added before the locations. Style modifiers each have a two-letter name. These abbreviated names are used to help reduce the length of the URL. To change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use a deep pink color which you would specify as #FF1493 in CSS, use `path=lcFF1493||-122 45|-119.5 43.2` Multiple style modifiers may be combined together to create a more complex visual style. `lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6` ### Getting Path locations from Azure Maps Data Storage For all Azure Maps account SKUs other than S0, the path location information can be obtained from Azure Maps Data Storage. After uploading a GeoJSON document containing path locations, the Data Storage service returns a Unique Data ID (UDID) that you can use to reference the data in the path parameter. To use the point geometry from an uploaded GeoJSON document as the path locations, specify the UDID in the locations section of the path parameter. For example, `path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713` Note the it is not allowed to mix path locations from Data Storage with locations specified in the path parameter. ### Style Modifier Summary Modifier | Description | Range :--------:|------------------------|------------------ lc | Line color | 000000 to FFFFFF fc | Fill color | 000000 to FFFFFF la | Line alpha (opacity) | 0 to 1 fa | Fill alpha (opacity) | 0 to 1 lw | Line width | Greater than 0 ra | Circle radius (meters) | Greater than 0 ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetMapTile (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. Fetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid)) **Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2)."
  }
}

⚼ Request

GET:  /map/tile/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Possible values are png & pbf. ,
Required: True ,
}
string ,
layer:
{
Description: Map layer requested. Possible values are basic, hybrid, labels and terra. ,
Required: True ,
}
string ,
style:
{
Description: Map style to be returned. Possible values are main, dark, and shaded_relief. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
tileSize:
{
Description: The size of the returned map tile in pixels. ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetMapStateTile (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapStateTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid)."
  }
}

⚼ Request

GET:  /map/statetile
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
statesetId:
{
Description: The stateset id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetCopyrightCaption (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. As an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetCopyrightCaption",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map.",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions for displaying the map provider information on the map."
  }
}

⚼ Request

GET:  /map/copyright/caption/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
formatVersion:
{
Description: Format Version property ,
Required: False ,
}
string ,
copyrightsCaption:
{
Description: Copyrights Caption property ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetMapImageryTile (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. The current available style value is 'satellite' which provides satellite imagery alone. **Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetMapImageryTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n The current available style value is 'satellite' which provides satellite imagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n The current available style value is 'satellite' which provides satellite imagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2)."
  }
}

⚼ Request

GET:  /map/imagery/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Possible value: png. ,
Required: True ,
}
string ,
style:
{
Description: Map style to be returned. __Possible values:__ satellite. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetCopyrightFromBoundingBox (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetCopyrightFromBoundingBox",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\n Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\n Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates"
  }
}

⚼ Request

GET:  /map/copyright/bounding/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
mincoordinates:
{
Description: Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 ,
Required: True ,
}
array ,
maxcoordinates:
{
Description: Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 ,
Required: True ,
}
array ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
text:
{
Description: Yes/no value to exclude textual data from response. Only images and country/region names will be in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
formatVersion:
{
Description: Format Version property ,
Required: False ,
}
string ,
generalCopyrights:
{
Description: General Copyrights array ,
Required: False ,
}
[
string ,
]
,
regions:
{
Description: Regions array ,
Required: False ,
}
[
{
copyrights:
{
Description: Copyrights array ,
Required: False ,
}
[
string ,
]
,
country:
{
Description: Country property ,
Required: False ,
}
{
ISO3:
{
Description: ISO3 property ,
Required: False ,
}
string ,
label:
{
Description: Label property ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetCopyrightForTile (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetCopyrightForTile",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\nTo obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\nTo obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid)."
  }
}

⚼ Request

GET:  /map/copyright/tile/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
text:
{
Description: Yes/no value to exclude textual data from response. Only images and country/region names will be in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
formatVersion:
{
Description: Format Version property ,
Required: False ,
}
string ,
generalCopyrights:
{
Description: General Copyrights array ,
Required: False ,
}
[
string ,
]
,
regions:
{
Description: Regions array ,
Required: False ,
}
[
{
copyrights:
{
Description: Copyrights array ,
Required: False ,
}
[
string ,
]
,
country:
{
Description: Country property ,
Required: False ,
}
{
ISO3:
{
Description: ISO3 property ,
Required: False ,
}
string ,
label:
{
Description: Label property ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Render_GetCopyrightForWorld (updated)
Description :  > [!NOTE] > > **Azure Maps Render v1 service retirement** > > The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26. The `Get Copyright For World` API is an HTTP `GET` request designed to serve copyright information for the Render Tile service. In addition to basic copyright for the whole map, it serves specific groups of copyrights for some countries. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Render_GetCopyrightForWorld",
  "Description": {
    "new": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps Render v1 service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use the [latest version](/rest/api/maps/render) of the Render API by 9/17/26.\n\nThe `Get Copyright For World` API is an HTTP `GET` request designed to serve copyright information for the Render Tile service. In addition to basic copyright for the whole map, it serves specific groups of copyrights for some countries. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.",
    "old": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use  [Render v2](/rest/api/maps/render) API by 9/17/26.\n\nThe `Get Copyright For World` API is an HTTP `GET` request designed to serve copyright information for the Render Tile service. In addition to basic copyright for the whole map, it serves specific groups of copyrights for some countries. To obtain the default copyright information for the whole world, do not specify a tile or bounding box."
  }
}

⚼ Request

GET:  /map/copyright/world/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
text:
{
Description: Yes/no value to exclude textual data from response. Only images and country/region names will be in response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
formatVersion:
{
Description: Format Version property ,
Required: False ,
}
string ,
generalCopyrights:
{
Description: General Copyrights array ,
Required: False ,
}
[
string ,
]
,
regions:
{
Description: Regions array ,
Required: False ,
}
[
{
copyrights:
{
Description: Copyrights array ,
Required: False ,
}
[
string ,
]
,
country:
{
Description: Country property ,
Required: False ,
}
{
ISO3:
{
Description: ISO3 property ,
Required: False ,
}
string ,
label:
{
Description: Label property ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}